core/androidx.core.app/[main]NotificationCompat/BubbleMetadata

BubbleMetadata

class BubbleMetadata(source)

Encapsulates the information needed to display a notification as a bubble.

A bubble is used to display app content in a floating window over the existing foreground activity. A bubble has a collapsed state represented by an icon, setIcon and an expanded state which is populated via setIntent.

Notifications with a valid and allowed bubble will display in collapsed state outside of the notification shade on unlocked devices. When a user interacts with the collapsed bubble, the bubble intent will be invoked and displayed.

See also

NotificationCompat.Builder

Types

Builder to construct a BubbleMetadata object.

Functions

@Nullable

open fun fromPlatform(platformMetadata: @Nullable Notification.BubbleMetadata): @Nullable NotificationCompat.BubbleMetadata

Converts a platform-level Notification.BubbleMetadata to a NotificationCompat.BubbleMetadata.

getAutoExpandBubble

open fun getAutoExpandBubble(): Boolean

getDeleteIntent

@Nullable

open fun getDeleteIntent(): @Nullable PendingIntent

getDesiredHeight

@Dimension(unit = 0)

open fun getDesiredHeight(): Int

getDesiredHeightResId

open fun getDesiredHeightResId(): Int

@Nullable

open fun getIcon(): @Nullable IconCompat

@Nullable

open fun getIntent(): @Nullable PendingIntent

@Nullable

open fun getShortcutId(): @Nullable String

isNotificationSuppressed

open fun isNotificationSuppressed(): Boolean

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun setFlags(flags: Int)

open fun toPlatform(@Nullable compatMetadata: @Nullable NotificationCompat.BubbleMetadata): @Nullable Notification.BubbleMetadata

Converts a NotificationCompat.BubbleMetadata to a platform-level Notification.BubbleMetadata.